Skip to main content

Installation

Starting with version 4.1, you can now use pdf2Data Parsing Engine through REST API.

important

You can find static documentation in SwaggerHub and also play around with the same Swagger UI live when you deploy the application.

Pull the Docker image​

docker pull public.ecr.aws/apryse/pdf2data-sdk-service:{version}

You need to explicitly specify the version when using the pull command. e.g. docker pull public.ecr.aws/apryse/pdf2data-sdk-service:4.2.0

caution

For installation of the application with version prior 4.2.0 you'll need to drop the public.ecr.aws/ prefix for all the images so that they were downloaded from Docker Hub instead

Start the Docker image​

docker run -p {host-port}:8080 -e PDF2DATA_SDK_REST_API_AUTH_TOKEN={token} --name {target-container-name} public.ecr.aws/apryse/pdf2data-sdk-service:{version}

where:

  • {host-port} - the port to which you would like to bind the application to. You can skip this parameter if you don't need to access the service directly from your machine, instead, you might want to use --expose 8080 parameter to access it from another container;
  • {token} - the access token to be used to authorize the requests to the service, min 16 characters;
  • {target-container-name} - the name of the container to create;
  • {version} - the version of the pdf2Data SDK REST service image, recent version can be checked in public AWS ECR registry.

For more options please consult with Docker run command documentation and SDK REST API: Customizing application settings.

Check your installation​

important

You can track the status of the service via http://localhost:{host-port}/api/status/health/ping endpoint and also check the deployed version via http://localhost:{host-port}/api/status/info.

Once the service is up and running you can use Swagger UI to examine what API consists of: http://localhost:{host-port}/api/swagger-ui/index.html.